[精選文章] 如何寫好一份 API 文件？
您寫作程式時，應該常常查閱一些 API 文件，以了解一個函數呼叫應該如何使用吧？但您知道，換成自己寫 API 文件時，應該注意哪些事情，才能寫出一份好的 API 文件呢？
又，您看國外原文參考文件時，是否常常看到以下不同名稱的文件、但卻無法分辨出它們之間的差別在哪裡呢？
(1) Reference Manual
(2) Cookbook
(3) Programmer's Guide
(4) Tutorial
(5) FAQ
以下這份文件雖然是英文的，但不長，而且圖表還算蠻清楚的。您可以參考一下，如何寫出一份令人滿意的 API 文件：
http://theamiableapi.com/2011/11/01/api-design-best-practice-write-helpful-documentation/
Search